Skip to content

Conversation

@yanjustino
Copy link
Contributor

This pull request includes several updates to documentation and code refactoring to improve readability and maintainability of test scenarios using the GherXunit library. The changes include updates to the versioning in the workflow file, enhancements to the QuickStart guide, and improvements to the README files in both English and Portuguese. Additionally, there are significant updates to the GherXunit.Core library, including new background context and step methods for testing.

Documentation updates:

  • QuickStart.md: Added a comprehensive guide on refactoring tests and extracting more readable scenarios using GherXunit, including examples of scenario definitions and step implementations.
  • README.md: Updated examples of test scenario definitions and step implementations, and improved the output format for test results. [1] [2] [3]
  • README_PTBR.md: Updated Portuguese examples of test scenario definitions and step implementations, and improved the output format for test results. [1] [2] [3]

Codebase improvements:

  • .github/workflows/dotnet.yml: Updated the versioning scheme from 1.1 to 1.2 to reflect the new changes.
  • GherXunit.Core/Attributes.cs: Simplified the FeatureAttribute and RuleAttribute descriptions by removing redundant prefixes.
  • GherXunit.Core/Backgrounds: Added new background context and step methods to handle blog post scenarios, including BackgroundTest.Context.cs, BackgroundTest.Steps.cs, and BackgroundTest.cs. [1] [2] [3]…s, enhance async handling, and improve scenario definitions
    This pull request introduces several changes to improve the documentation and refactor the test code for better readability and maintainability. The most important changes include updating the version in the workflow file, adding comprehensive examples and explanations in the QuickStart.md, and refactoring the BackgroundTest class to use the Gherkin syntax for defining test scenarios.

Documentation Improvements:

  • QuickStart.md: Added detailed explanations and examples on how to refactor test code using GherXunit to improve readability and maintainability.

Refactoring and Code Improvements:

Workflow Update:

…s, enhance async handling, and improve scenario definitions
@yanjustino yanjustino added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 8, 2025
@yanjustino yanjustino self-assigned this Mar 8, 2025
@yanjustino yanjustino merged commit 8fe8149 into main Mar 8, 2025
1 check passed
@yanjustino yanjustino deleted the feature/20250307 branch March 8, 2025 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants